home *** CD-ROM | disk | FTP | other *** search
/ Night Owl 6 / Night Owl's Shareware - PDSI-006 - Night Owl Corp (1990).iso / 007a / cards10.zip / MANUAL.DOC < prev    next >
Text File  |  1991-09-20  |  12KB  |  288 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.                               The Cardfile Program
  29.                        (c) Copyright 1991 Thomas Kellar
  30.  
  31.  
  32.  
  33.  
  34.  
  35.                                  Cardfile
  36.  
  37. Cardfile is a program written to allow the simulation of a 3 by 5 card deck
  38. or a simple data entry system that can be used for adding records, altering
  39. records, deleting records, and looking up records. Cardfile requires three
  40. files to run:
  41.  
  42.      - The prompt file that contains screen addresses of prompts and
  43.        the prompts and the field type and the field width.  This file
  44.        is created by the user of the Cardfile program although several
  45.        samples are provided.
  46.  
  47.      - The data file.  This file is either an already existing file used
  48.        previously by Cardfile or a file created by Cardfile.  Unless set
  49.        by the user of the program the name will be the same as the prompt
  50.        file with a ".cda" suffix (extension) attached to it.
  51.  
  52.      - The configuration file.  This file is created and maintained by
  53.        Cardfile to store Setup information in.
  54.  
  55. Cardfile was written in C on and for any MDDOS 2.10 or greater release of
  56. software running on a PC or XT or AT or anything related.  It works in as
  57. little as 128K bytes of free memory.
  58.  
  59. The Cardfile program is a copyrighted program that cannot be copied except
  60. for the purposes of backup or to look at to see if it meets your needs.
  61. If you wish to use this program (i.e. if you find it useful) please send
  62. 20 US dollars to Thomas Kellar at 807 St. Nicholas Ave. Dayton, Ohio 45410
  63. to help defray the costs of developing it. (I.e. to help buy some food.)
  64. Also please feel free to send positive constructive criticism  as well.
  65.  
  66.  
  67.  
  68.  
  69.                             Main Menu
  70.  
  71. The Main menu selection appears after typing the Esc key from the prompt
  72. screen or after initialization if the Cardfile program could not find the
  73. the command line named prompt file (or if none was given).
  74.  
  75.  
  76. The "Compress Data File" option removes all the blank (deleted) cards
  77. from within the Cardfile data base and places them at the end.  It is not
  78. ever absolutely necessary to run this option but it is there if the user
  79. deletes a lot of cards and does not want to re-use them.
  80.  
  81. The "Setup" entry is for the alteration of Cardfile program parameters.
  82.  
  83. The "Load" entry is to alter the current (if any) prompt file to a new one.
  84. If you change the prompt file while the program is running, the program will
  85. also prompt you for a new data file as it is assumed that the new prompt file
  86. will not use the same data as the previous one.
  87.  
  88. The "Load/Create" entry is to change to a new Cardfile data base file.
  89.  
  90. "Help" is to display information about various screens in this program and
  91. to display information about the Cardfile program.
  92.  
  93. "Exit" is to leave the Cardfile program.  The selection confirms your
  94. choice to exit before it actually does.
  95.  
  96.  
  97.  
  98.                               Setup Menu
  99.  
  100. The "Change the Screen Size" entry is a useful if you have a VGA or SVGA
  101. The VGA can display up to 43 lines of 132 characters.  This function changes
  102. the screen size by setting the video controller to mode 84 which is the
  103. large screen video mode.  SVGA controllers might have a 60 line by 132
  104. character mode display and this entry changes the screen to it by setting
  105. the video controller to mode 90.  The selection is a rotary: it starts at
  106. 25 by 80 then selecting it once changes the screen size to 43 by 132 and
  107. selecting it again sets the size to 60 by 132 (if supported) then finally
  108. selecting it a third time returns the screen to normal 25 by 80.
  109.  
  110. The "Change the Screen Colors" selection can alter the background and
  111. foreground (characters) colors to whatever you want. This is, of course,
  112. useful only with a color display
  113.  
  114. The "Clock Feature" alternately enables or disables the display of the
  115. clock in the upper right hand corner the screen. The space the time display
  116. takes up might be needed by prompts and note that the clock display uses
  117. direct video memory writes and should be eliminated if this program is run
  118. from inside a multi-tasking program.
  119.  
  120. The "Legend Display" selection toggles the display of the keys on the top
  121. two lines of the data entry screen on or off. This might be needed to make
  122. the screen area more useful.
  123.  
  124.  
  125.  
  126.                           The Data File
  127.  
  128. The data file used by Cardfile is used for storage and retrieval of the
  129. cards that are entered by the user of this program.  The file is either
  130. a named input to this program (second entry on the start up command line)
  131. or the name of the input prompt file with a ".cda" suffix attached or
  132. the name "cardfile.cda" or any file selected from the Main Menu entry
  133. designed to do so.
  134.  
  135. The data file uses fixed record sizes and the records are not generally
  136. terminated by carriage return/line feed sequences although through the
  137. use of the type 6 field/prompt the user can generate them if he or she
  138. wishes.
  139.  
  140. Generally, it is better to keep record sizes short as this consumes less
  141. filespace and searches (F3 find) are faster.
  142.  
  143. If you want to use the data file with other programs such as word processors
  144. then you want to use the type 6 field at the end of the prompt file (ie,
  145. the last entry before the -2 line).
  146.  
  147.  
  148.  
  149.  
  150.                        Data Entry Prompt Screen Keys
  151.  
  152.  There are twelve special function keys in the Data Entry mode of Cardfile:
  153.  
  154.     Key                           Function
  155.  
  156.     F1       The card that is being displayed on the screen is written as
  157.              an addition to the end of cardfile database (Insert).
  158.  
  159.     F2       starts a search of the cardfile database from the current
  160.              position in it until the end of the file.  The search is
  161.              based on the field the cursor is currently in.  Note that
  162.              the maximum characters that will be searched for is 119 and
  163.              blanks are stripped off the field before the search starts.
  164.  
  165.     F3       Deletes the card currently being displayed.  It asks for
  166.              a confirmation before actually deleting it (Delete).
  167.  
  168.     F4       Overwrites the currently being displayed card with whatever
  169.              is on the screen.  You can call up one record and change the
  170.              data then re-write it using this key.
  171.  
  172.     F5       Display the next sequential card in the database (Page Down).
  173.  
  174.     F6       Display the previous sequential card in the database (Page Up).
  175.  
  176.     F7       Clear the current display (not the current card) and move the
  177.              cursor to the upper first prompt on the screen (defined as the
  178.              first prompt in the prompt file) so that the  operator can type
  179.              in a new card.
  180.  
  181.     Home     Display the first record in the cardfile database.
  182.  
  183.     End      Display the last record in the cardfile database.
  184.  
  185.     Esc      Go to the main menu of the cardfile program.  This menu is
  186.              not used for normal data entry functions.
  187.  
  188.     F8       Save the current field to a holding buffer.
  189.  
  190.     F9       Restore the saved field to the screen card.  This key is the
  191.              reverse of the F8 key.
  192.  
  193.     Tab and arrow and backspace keys move the cursor around the fields.
  194.  
  195.     Tab and Return/Enter shift between fields.
  196.  
  197.     The left and right arrows move in the field unless at the bounds of
  198.     a field where the right arrow causes a skip to the next field and the
  199.     left arrow just sits there.  The backspace key and the left arrow key
  200.     act the same.
  201.  
  202.  
  203.  
  204.  
  205.                              The Prompt File
  206.  
  207. The prompt file is an ASCII file that contains information that describes
  208. the screen layout and field type and field size. There are seven entries
  209. on each line (except the last one) with one screen prompt and field to each.
  210. (This is not strict.)  The entries are, listed in order, as follows:
  211.  
  212. -1 is the first which is an indicator to the software that says here is
  213. the start of a prompt.
  214.  
  215. Next are two entries comprising the screen position of the prompt that will
  216. appear on the screen in units of row, column with the nominal range of 0 to
  217. 132 for the column and 0 to 59 for the row. It must be noted that a VGA and
  218. a SVGA are required to go to 43 rows and 60 rows with 132 columns
  219. respectively.
  220.  
  221. Next is the field length of the data to be entered.  It can zero or one
  222. characters or it can be any other number such as 10, 20 or 400 or greater
  223. characters with two built in limitations, first the limit of the screen size
  224. and second the limit of about 8000 bytes (based on memory). If the field length
  225. is zero then the prompt becomes a display only field with no input or output
  226. data field associated.
  227.  
  228. The displaying prompt is next, it is proceeded by a quote (") and should
  229. not extend beyond the end of a physical screen line or cause the data entry
  230. field to do so either. It must use underscores instead of spaces.  (This_is
  231. _an_example_of_that.) Note that the maximum prompt length is 130 and that if
  232. your prompt consists of a set if double quotes, no prompt will display.
  233.  
  234. The next field is the type of data field, there are four types defined, a:
  235.  
  236.      1  designates an alphanumeric field (punctuation characters too).
  237.  
  238.      2  designates a numeric only field (digits 0..9).
  239.  
  240.      3  designates an alphanumeric comment field (same as the 1 but the
  241.         3 field politely extends across multiple screen lines.
  242.  
  243.      4  designates an automatically generated date field (the field must
  244.         be 10 bytes long).
  245.  
  246.      5  designates an alpha only field (spaces are allowed).
  247.  
  248.      6  designates a field that generates a carriage return line feed
  249.         sequence (the field must be 2 bytes wide).
  250.  
  251. The last entry is for future considerations and is not defined yet.
  252.  
  253. Finally, a -2 is used on a line by itself to denote the end of the prompt
  254. file.  (The end-of-file of the prompt file works too.)
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.  
  262.  
  263. An example of a prompt file is the phone.cfg prompt file below:
  264.  
  265.         -1   3 30   0  "Telephone_Directory         1   1
  266.         -1   5  4   3  "Home_Phone_Area_code:       2   1
  267.         -1   5 32   7  "Telephone:                  2   1
  268.         -1   7  4   3  "Work_number_Area_code:      2   1
  269.         -1   7 32   7  "Telephone:                  2   1
  270.         -1   9  4  20  "First_Name:                 1   1
  271.         -1   9 40  20  "Last_Name:                  1   1
  272.         -1  11  4  20  "Company:                    1   1
  273.         -1  13  9 100  "Address:                    3   1
  274.         -1  18  2  10  "Date:                       4   1
  275.         -1  18 30   2  ""                           6   1
  276.         -2
  277.  
  278. The first line starts with a -1, as required, then has a 3 30 sequence of
  279. integers which is the row and column where the prompt will be placed, next
  280. is a 0 which is the field length, 0 indicates that this is a display only
  281. prompt that does not generate any data and is not entered by the operator.
  282. Next is the prompt as it appears on the screen with out the preceeding quote,
  283. and following that is an integer 1 that (irrelevantly as this is a display
  284. only field) indicates the field type.  Finally there is a 1 on the line that
  285. is the last field in each line.  It is not used.  Following all this is
  286. a -2 which indicates to Cardfile that this is the end of the prompt file.
  287.  
  288.